home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / Xm / XmCvtTextPropertyToXmStringTable.z / XmCvtTextPropertyToXmStringTable
Encoding:
Text File  |  2001-04-17  |  8.8 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmCCCCvvvvttttTTTTeeeexxxxttttPPPPrrrrooooppppeeeerrrrttttyyyyTTTTooooXXXXmmmmSSSSttttrrrriiiinnnnggggUUUUTTTTNNNNaaaaIIIIbbbbXXXXXXXXllllmmmmeeeeSSSSCCCC((((yyyyvvvv3333ssssttttXXXXttttTTTT))))eeeeeeeemmmmxxxxttttVVVVPPPPrrrrooooppppeeeerrrrttttyyyyTTTTooooXXXXmmmmSSSSttttrrrriiiinnnnggggTTTTaaaabbbblllleeee((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmCCCCvvvvttttTTTTeeeexxxxttttPPPPrrrrooooppppeeeerrrrttttyyyyTTTTooooXXXXmmmmSSSSttttrrrriiiinnnnggggTTTTaaaabbbblllleeee - A function that converts
  10.           from a TextProperty Structure to a StringTable
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           #include <Xm/Xm.h>
  14.           int XmCvtTextPropertyToXmStringTable (_d_i_s_p_l_a_y, _t_e_x_t__p_r_o_p, _s_t_r_i_n_g__t_a_b_l_e__r_e_t_u_r_n, _c_o_u_n_t__r_e_t_u_r_n)
  15.                   Display *_d_i_s_p_l_a_y;
  16.                   XTextProperty   *_t_e_x_t__p_r_o_p;
  17.                   XmStringTable   *_s_t_r_i_n_g__t_a_b_l_e__r_e_t_u_r_n;
  18.                   int     *_c_o_u_n_t__r_e_t_u_r_n;
  19.           (vvvvooooiiiidddd)
  20.  
  21.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  22.           This page documents Motif 2.1.
  23.  
  24.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  25.           XXXXmmmmCCCCvvvvttttTTTTeeeexxxxttttPPPPrrrrooooppppeeeerrrrttttyyyyTTTTooooXXXXmmmmSSSSttttrrrriiiinnnnggggTTTTaaaabbbblllleeee converts the specified
  26.           _X_T_e_x_t_P_r_o_p_e_r_t_y structure into an XXXXmmmmSSSSttttrrrriiiinnnnggggTTTTaaaabbbblllleeee, as follows:
  27.  
  28.              +o  If the encoding member of _t_e_x_t__p_r_o_p is the Atom
  29.                 _S_T_R_I_N_G, each returned XXXXmmmmSSSSttttrrrriiiinnnngggghas a tag of "ISO8859-1"
  30.                 and a text type of XXXXmmmmCCCCHHHHAAAARRRRSSSSEEEETTTT____TTTTEEEEXXXXTTTT.
  31.  
  32.              +o  If the encoding member of _t_e_x_t__p_r_o_p is the encoding of
  33.                 the current locale, and if that encoding is not
  34.                 _S_T_R_I_N_G, each returned XXXXmmmmSSSSttttrrrriiiinnnngggg has a tag of
  35.                 ____MMMMOOOOTTTTIIIIFFFF____DDDDEEEEFFFFAAAAUUUULLLLTTTT____LLLLOOOOCCCCAAAALLLLEEEE and a text type of
  36.                 XXXXmmmmMMMMUUUULLLLTTTTIIIIBBBBYYYYTTTTEEEE____TTTTEEEEXXXXTTTT.
  37.  
  38.              +o  If the encoding member of _t_e_x_t__p_r_o_p is other than
  39.                 _S_T_R_I_N_G or the encoding of the current locale, the
  40.                 contents of the returned compound strings are
  41.                 implementation dependent.
  42.  
  43.           If conversion depends on the locale and the current locale
  44.           is not supported, the function returns XXXXLLLLooooccccaaaalllleeeeNNNNoooottttSSSSuuuuppppppppoooorrrrtttteeeedddd.
  45.           If conversion to the encoding of the current locale is
  46.           required and if the locale is supported but no converter is
  47.           available for the encoding specified in _t_e_x_t__p_r_o_p, the
  48.           function returns XXXXCCCCoooonnnnvvvveeeerrrrtttteeeerrrrNNNNoooottttFFFFoooouuuunnnndddd. For supported locales,
  49.           existence of a converter from _C_O_M_P_O_U_N_D__T_E_X_T, _S_T_R_I_N_G, or the
  50.           encoding of the current locale is guaranteed if
  51.           XXXXSSSSuuuuppppppppoooorrrrttttssssLLLLooooccccaaaalllleeee returns True for the current locale (but the
  52.           actual text may contain unconvertible characters).
  53.           Conversion of other encodings to the encoding of the current
  54.           locale is implementation dependent. In all of these error
  55.           cases, the function does not set any return values.
  56.  
  57.           If an element of the value member of _t_e_x_t__p_r_o_p is not
  58.           convertible to XXXXmmmmSSSSttttrrrriiiinnnngggg, the corresponding entry in the
  59.           returned XXXXmmmmSSSSttttrrrriiiinnnnggggTTTTaaaabbbblllleeee will be NULL, and
  60.  
  61.  
  62.  
  63.      Page 1                                           (printed 4/6/01)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmCCCCvvvvttttTTTTeeeexxxxttttPPPPrrrrooooppppeeeerrrrttttyyyyTTTTooooXXXXmmmmSSSSttttrrrriiiinnnnggggUUUUTTTTNNNNaaaaIIIIbbbbXXXXXXXXllllmmmmeeeeSSSSCCCC((((yyyyvvvv3333ssssttttXXXXttttTTTT))))eeeeeeeemmmmxxxxttttVVVVPPPPrrrrooooppppeeeerrrrttttyyyyTTTTooooXXXXmmmmSSSSttttrrrriiiinnnnggggTTTTaaaabbbblllleeee((((3333XXXX))))
  71.  
  72.  
  73.  
  74.           XXXXmmmmCCCCvvvvttttTTTTeeeexxxxttttPPPPrrrrooooppppeeeerrrrttttyyyyTTTTooooXXXXmmmmSSSSttttrrrriiiinnnnggggTTTTaaaabbbblllleeee returns Success.
  75.  
  76.           To free the storage for the XXXXmmmmSSSSttttrrrriiiinnnnggggTTTTaaaabbbblllleeee and its
  77.           _c_o_u_n_t__r_e_t_u_r_n compound strings returned by this function,
  78.           first free each XXXXmmmmSSSSttttrrrriiiinnnngggg in the table using XXXXmmmmSSSSttttrrrriiiinnnnggggFFFFrrrreeeeeeee,
  79.           and then free the XXXXmmmmSSSSttttrrrriiiinnnnggggTTTTaaaabbbblllleeee itself using XXXXttttFFFFrrrreeeeeeee.
  80.  
  81.           _d_i_s_p_l_a_y   Specifies the connection to the X server.
  82.  
  83.           _t_e_x_t__p_r_o_p Specifies a pointer to the _X_T_e_x_t_P_r_o_p_e_r_t_y.  The
  84.                     format member of _t_e_x_t__p_r_o_p must be 8.
  85.  
  86.           _s_t_r_i_n_g__t_a_b_l_e__r_e_t_u_r_n
  87.                     Specifies the XXXXmmmmSSSSttttrrrriiiinnnnggggTTTTaaaabbbblllleeee array into which the
  88.                     converted compound strings are placed.
  89.  
  90.           _c_o_u_n_t__r_e_t_u_r_n
  91.                     Specifies the number of XXXXmmmmSSSSttttrrrriiiinnnnggggs returned by this
  92.                     function.
  93.  
  94.      RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEESSSS
  95.           Upon success, this function returns the set of XXXXmmmmSSSSttttrrrriiiinnnnggggs in
  96.           _s_t_r_i_n_g__t_a_b_l_e__r_e_t_u_r_n, and it returns the number of XXXXmmmmSSSSttttrrrriiiinnnnggggs
  97.           in _c_o_u_n_t__r_e_t_u_r_n, and returns Success. Otherwise, it returns
  98.           the following:
  99.  
  100.           XXXXLLLLooooccccaaaalllleeeeNNNNoooottttSSSSuuuuppppppppoooorrrrtttteeeedddd
  101.                     Returned if conversion depends on the locale and
  102.                     the current locale is not supported.
  103.  
  104.           XXXXCCCCoooonnnnvvvveeeerrrrtttteeeerrrrNNNNoooottttFFFFoooouuuunnnndddd
  105.                     Returned if conversion to the encoding of the
  106.                     current locale is required and if the locale is
  107.                     supported but no converter is available for the
  108.                     encoding specified in _t_e_x_t__p_r_o_p.
  109.  
  110.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  111.           XXXXmmmmCCCCvvvvttttXXXXmmmmSSSSttttrrrriiiinnnnggggTTTTaaaabbbblllleeeeTTTTooooTTTTeeeexxxxttttPPPPrrrrooooppppeeeerrrrttttyyyy(3), XXXXmmmmTTTTeeeexxxxtttt(3), and
  112.           XXXXmmmmTTTTeeeexxxxttttGGGGeeeettttSSSSttttrrrriiiinnnngggg(3).
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                           (printed 4/6/01)
  130.  
  131.  
  132.  
  133.